Use EffectStack2D to apply multiple post-processing effects to 2D nodes. More...

#include <kanzi/core.ui/effect/effect_stack2d.hpp>

Inheritance diagram for kanzi::EffectStack2D:

Public Types
using	ChildConstSpan
	Child span type.

using	ChildContainer
	Container type for children.

enum class	StackingMode { Chained , Layered }
	Defines the stacking modes you can apply to child effects. More...

Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Types inherited from kanzi::BindingHostConcept
using	BindingHostConceptSharedPtr
	Binding host concept shared pointer type.

using	BindingRuntimeConstIterator
	Const iterator for binding runtimes.

using	BindingRuntimeContainer
	Container for binding runtimes.

using	BindingRuntimeIterator
	Iterator for binding runtimes.

Public Member Functions
void	addChild (NodeEffect2DSharedPtr childEffect)
	Adds an effect as the last child of the effect stack.

NodeEffect2DSharedPtr	getChild (unsigned int index)
	Gets a child effect at a given index.

unsigned int	getChildCount () const
	Returns the number of child effects.

unsigned int	getChildIndex (NodeEffect2D &childEffect) const
	Gets the index of a child in this effect.

ChildConstSpan	getChildren () const
	Gets a span of child effects.

void	insertChild (unsigned int index, NodeEffect2DSharedPtr childEffect)
	Adds an effect as a child of the effect stack at a given index.

void	removeAllChildren ()
	Removes all child effects from the effect stack.

void	removeChild (NodeEffect2D &childEffect)
	Removes a child effect.

void	removeChild (unsigned int index)
	Removes the child effect at a given index.

Public Member Functions inherited from kanzi::NodeEffect2D
void	attach (Node *node)
	Attaches the node effect.

BindingLookupContextPtr	createLookupContext (NodeEffect2DSharedPtr templateRoot)
	Creates a lookup context for a given effect.

NodeEffectRenderer2DUniquePtr	createRenderer ()
	Creates a renderer instance.

void	detach ()
	Detaches the node effect.

unsigned int	getEffectPaddingChangeCounter () const
	Gets the effect quad padding change counter.

Vector4	getEffectQuadPadding () const
	Gets the effect quad padding.

Vector2	getEffectQuadPaddingOffset () const
	Gets the effect quad offset relative relative to the top-left corner of the node.

Vector2	getEffectQuadPaddingSize () const
	Gets the effect quad padding size.

bool	getEnabled () const
	Gets the value of EnabledProperty.

Node *	getHostNode () const
	Gets the node that hosts the effect.

NodeEffect2D *	getParent () const
	Gets the parent of a node effect.

NodeEffectRenderer2D *	getRendererInstance () const
	Gets a pointer to NodeEffectRenderer2D instance or null pointer if none exists.

NodeEffect2DSharedPtr	getTemplateRoot () const
	Gets the template root of this node effect.

bool	isAlphaRequired () const
	Indicates whether the effect requires alpha channel for the result.

bool	isAttached () const
	Returns whether a node effect is attached to a node.

bool	isAttaching () const
	Returns whether a node effect is attaching to a node.

bool	isDetached () const
	Returns whether a node effect is detached from a node.

bool	isDetaching () const
	Returns whether a node effect is detaching from a node.

bool	isRenderingRequired ()
	Indicates whether the effect requires rendering.

ObjectSharedPtr	lookupObject (string_view relativePath)
	Lookup for an object from the effect.

template<typename T >
shared_ptr< T >	lookupObject (string_view relativePath)
	Lookup a relative object of a given type.

void	setEffectPaddingChangeCounter (unsigned int value)
	Sets the effect quad padding change counter.

void	setEnabled (bool value)
	Sets the value of EnabledProperty.

void	setParent (NodeEffect2D *parent)
	Sets the parent of a node effect.

void	setTemplateRoot (NodeEffect2DSharedPtr templateRoot)
	Sets the template root for this node effect.

void	unregisterEffectRenderer (NodeEffectRenderer2D *effectRenderer)
	Unregister effect renderer.

	~NodeEffect2D ()

Public Member Functions inherited from kanzi::Resource
virtual unsigned int	getCPUMemoryUsage () const
	Function for getting the memory usage of a resource.

const string &	getName () const
	Gets the resource name.

const string &	getUrl () const
	Gets the resource URL.

bool	isKeepAlive () const
	Tells if the resource has keep alive flag set.

void	reload ()

void	reloadFromFile (string_view filePath)

void	reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

void	setKeepAlive (bool keepAlive)
	Sets the keep alive flag.

void	setUrl (string_view url)
	Sets the resource URL.

	~Resource () override
	Destructor.

Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object.

void	applyObjectStyles ()
	Apply all styles for an object node.

Domain *	getDomain () const
	Returns the domain the object belongs to.

const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object.

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain.

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object.

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object.

ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object.

	Object (Domain *domain)

void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object.

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles.

	~Object () override

Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it.

virtual	~MetaObject ()

Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
	Adds a property modifier without notifying handlers.

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)

PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container.

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object.

void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object.

PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value.

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers.

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type.

bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers.

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property.

bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property.

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value.

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

	PropertyObject ()

void	removeKzbProperties ()
	Remove all KZB properties.

void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set.

template<typename DataType >
void	removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property.

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property type.

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

KZ_DEPRECATED void	validatePropertyModifiers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

void	validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

virtual	~PropertyObject ()

Public Member Functions inherited from kanzi::BindingHostConceptImpl< NodeEffect2D >
void	addBindingRuntime (AbstractBindingRuntimeSharedPtr entry, shared_ptr< void > owner)
	Adds an already-created binding runtime to this binding host.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding)
	Wrapper for setting a binding with no target.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
	Wrapper for setting a binding.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a binding.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
	Wrapper for setting a binding.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
	Wrapper for setting a binding.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, shared_ptr< NodeEffect2D > templateRoot)
	Sets a binding with no target.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, shared_ptr< NodeEffect2D > templateRoot, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a binding.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, shared_ptr< NodeEffect2D > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
	Wrapper for setting a binding.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, shared_ptr< NodeEffect2D > templateRoot, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
	Wrapper for setting a binding.

BindingRuntimeHandle	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner)
	Wrapper for setting a binding with no target.

BindingRuntimeHandle	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
	Wrapper for setting a binding with owner.

BindingRuntimeHandle	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
	Wrapper for setting a binding with owner.

BindingRuntimeHandle	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< NodeEffect2D > templateRoot)
	Sets a binding with no target.

BindingRuntimeHandle	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< NodeEffect2D > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
	Sets a binding to a certain property.

BindingRuntimeHandle	setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
	Wrapper for setting a modifier binding.

BindingRuntimeHandle	setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a modifier binding.

BindingRuntimeHandle	setModifierBinding (AbstractBindingSharedPtr binding, shared_ptr< NodeEffect2D > templateRoot, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a modifier binding.

BindingRuntimeHandle	setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
	Wrapper for setting a modifier binding.

BindingRuntimeHandle	setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a modifier binding.

BindingRuntimeHandle	setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< NodeEffect2D > templateRoot, AbstractPropertyType propertyType, PropertyField field)
	Sets a modifier binding.

Public Member Functions inherited from kanzi::BindingHostConcept
BindingRuntimeConstIterator	beginBindingRuntimes () const
	Returns an iterator to the beginning of binding runtimes.

BindingRuntimeConstIterator	endBindingRuntimes () const
	Returns an iterator to the end of binding runtimes.

AbstractBindingRuntimeSharedPtr	getBindingRuntime (size_t idx)
	Gets binding by index.

size_t	getBindingRuntimeCount () const
	Gets the number of binding runtimes added to this node.

void	removeAllBindings ()
	Removes all binding runtimes.

void	removeBinding (BindingRuntimeHandle &bindingRuntime)
	Removes a binding runtime added earlier.

void	removeBindingsWithOwner (shared_ptr< void > owner)
	Removes all binding runtimes with the specified owner.

Static Public Member Functions
static EffectStack2DSharedPtr	create (Domain *domain, string_view name)
	Creates an effect stack.

static StackingMode	getStackingMode (const NodeEffect2D &effect)
	Gets the value of StackingModeProperty.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

static void	setStackingMode (NodeEffect2D &effect, StackingMode value)
	Sets the value of StackingModeProperty.

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Static Public Attributes
static PropertyType< StackingMode >	StackingModeProperty
	Sets the effect stacking mode.

Static Public Attributes inherited from kanzi::NodeEffect2D
static PropertyType< bool >	EnabledProperty
	Sets whether the effect is enabled.

Protected Member Functions
NodeEffectRenderer2DUniquePtr	createRendererOverride () override
	NodeEffect2D::createRendererOverride implementation.

	EffectStack2D (Domain *domain, string_view name)
	Constructor.

void	initializeRendererOverride () override
	NodeEffect2D::initializeRendererOverride implementation.

bool	isRenderingRequiredOverride () override
	NodeEffect2D::isRenderingRequiredOverride() implementation.

ObjectSharedPtr	lookupObjectOverride (string_view initialPart, string_view remainingPart) override
	NodeEffect2D::lookupObjectOverride() implementation.

void	onAttached () override
	NodeEffect2D::onAttached() implementation.

void	onDetached () override
	NodeEffect2D::onDetached() implementation.

void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
	Node2D::onPropertyChanged() implementation.

void	updateEffectQuadPadding ()
	Updates NodeEffect2D effect quad padding based on the current child effects.

Protected Member Functions inherited from kanzi::NodeEffect2D
	NodeEffect2D (Domain *domain, string_view name)
	Constructor.

void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
	PropertyObject::onPropertyChanged implementation.

void	setAlphaRequired (bool required)
	Sets the framebuffer alpha channel requirements of the effect.

void	setEffectQuadPadding (float left, float right, float top, float bottom)
	Sets the padding required by the effect around the node bounds during the rendering of the effect.

Protected Member Functions inherited from kanzi::Resource
virtual unsigned int	getCPUMemoryUsageOverride () const

virtual void	reloadFromFileOverride (string_view filePath)

virtual void	reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

virtual void	reloadOverride ()

	Resource (Domain *domain, string_view name)
	Constructor.

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Protected Member Functions inherited from kanzi::MetaObject
void	initialize ()

	MetaObject ()

Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value.

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

template<typename DataType >
void	addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
	Adds a property modifier entry to the property modifier stack and validates them.

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)
	Internally adds a property value source.

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)
	Internally adds a property value source.

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage.

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor.

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names.

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor.

virtual void	notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
	Notifies all property handlers on a property storage.

void	onCopy (const PropertyObject &other)

void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage.

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)
	Removes a property value source.

void	validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers without notifying handlers.

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers and notifies handlers.

Protected Member Functions inherited from kanzi::BindingHostConceptImpl< NodeEffect2D >
NodeEffect2D *	getThisObject ()
	Internal accessor for the Curiously Recurring Template Pattern.

const NodeEffect2D *	getThisObject () const
	Internal accessor for the Curiously Recurring Template Pattern.

Protected Member Functions inherited from kanzi::BindingHostConcept
void	attachBindings ()
	Attach all bindings stored in this object.

void	detachBindings ()
	Detach bindings.

Protected Attributes
ChildContainer	m_children
	Child effects.

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object.

Protected Attributes inherited from kanzi::BindingHostConcept
BindingRuntimeContainer	m_bindingRuntimes
	Bindings in this object.

Additional Inherited Members
Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container.

Detailed Description

Use EffectStack2D to apply multiple post-processing effects to 2D nodes.

Examples

To assign multiple effects to a node:

    // Create an outline effect template.
    NodeEffectTemplate2DSharedPtr outlineEffectTemplate =
        NodeEffectTemplate2D::create(OutlineEffect2D::getStaticMetaclass()->getName(), "OutlineEffect");
 
    // Set the value of the WidthProperty in the outline effect template.
    // The WidthProperty defines the maximum width of the outline outside the content area.
    outlineEffectTemplate->addPropertyValue(OutlineEffect2D::WidthProperty, Variant(8));
 
    // Create an effect stack template.
    NodeEffectTemplate2DSharedPtr effectStackTemplate = NodeEffectTemplate2D::create(EffectStack2D::getStaticMetaclass()->getName(), "Group");
 
    // Add the outline effect template to the effect stack template.
    effectStackTemplate->addChild(outlineEffectTemplate);
 
    // Create a shadow effect template and add it to the effect stack template.
    effectStackTemplate->addChild(NodeEffectTemplate2D::create(ShadowEffect2D::getStaticMetaclass()->getName(), "DropShadow"));
 
    // Create a prefab from the effect stack template.
    NodeEffectPrefab2DSharedPtr effectStackPrefab =
        NodeEffectPrefab2D::create(getDomain(), "Effect Stack prefab", effectStackTemplate);
 
    // Set a 2D node to use the effect stack prefab.
    // This way, you apply to the node both the outline and the shadow effect.
    node->setEffectPrefab(effectStackPrefab);

See also: NodeEffect2D, NodeEffectPrefab2D, NodeEffectTemplate2D

Since: Kanzi 3.9.8

Member Typedef Documentation

◆ ChildContainer

using kanzi::EffectStack2D::ChildContainer

Container type for children.

◆ ChildConstSpan

using kanzi::EffectStack2D::ChildConstSpan

Child span type.

Member Enumeration Documentation

◆ StackingMode

enum class kanzi::EffectStack2D::StackingMode

strong

Defines the stacking modes you can apply to child effects.

Enumerator
Chained	Child effect uses as its input the result of a previous effect, the combined result of a sequence of layered effects, or the node content. The next effect uses as its input the result of this effect.
Layered	Child effect uses as its input either the result of a previous chained effect or the node content. A sequence of layered effects are combined on top of each other in layers.

Constructor & Destructor Documentation

◆ EffectStack2D()

kanzi::EffectStack2D::EffectStack2D	(	Domain *	domain,
		string_view	name )

explicitprotected

Constructor.

Parameters

domain	Domain to use.
name	Resource name.

Member Function Documentation

◆ getStackingMode()

static StackingMode kanzi::EffectStack2D::getStackingMode ( const NodeEffect2D & effect )

inlinestatic

Gets the value of StackingModeProperty.

See also: setStackingMode()

◆ setStackingMode()

static void kanzi::EffectStack2D::setStackingMode	(	NodeEffect2D &	effect,
		StackingMode	value )

inlinestatic

Sets the value of StackingModeProperty.

See also: getStackingMode()

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::EffectStack2D::makeEditorInfo ( )

static

◆ create()

static EffectStack2DSharedPtr kanzi::EffectStack2D::create	(	Domain *	domain,
		string_view	name )

static

Creates an effect stack.

Parameters

domain	Domain to use.
name	Resource name.

Returns: Shared pointer to the created EffectStack2D instance.

◆ addChild()

void kanzi::EffectStack2D::addChild ( NodeEffect2DSharedPtr childEffect )

Adds an effect as the last child of the effect stack.

Parameters

childEffect The effect to add.

◆ insertChild()

void kanzi::EffectStack2D::insertChild	(	unsigned int	index,
		NodeEffect2DSharedPtr	childEffect )

Adds an effect as a child of the effect stack at a given index.

Parameters

index	The index at which to insert the child effect.
childEffect	The effect to add.

◆ getChildIndex()

unsigned int kanzi::EffectStack2D::getChildIndex ( NodeEffect2D & childEffect ) const

Gets the index of a child in this effect.

Throws an exception if the given effect is not a child of this effect stack.

Parameters

childEffect Child effect whose index to query.

Returns: Index of the child effect.

◆ removeChild() [1/2]

void kanzi::EffectStack2D::removeChild ( NodeEffect2D & childEffect )

Removes a child effect.

Throws an exception if the given effect is not a child of this effect.

Parameters

childEffect The effect to remove.

◆ removeChild() [2/2]

void kanzi::EffectStack2D::removeChild ( unsigned int index )

Removes the child effect at a given index.

Parameters

index Index of the child effect to remove.

◆ removeAllChildren()

void kanzi::EffectStack2D::removeAllChildren ( )

Removes all child effects from the effect stack.

◆ getChild()

NodeEffect2DSharedPtr kanzi::EffectStack2D::getChild ( unsigned int index )

inline

Gets a child effect at a given index.

Throws an error if the index is invalid.

Parameters

index The index of the child effect that you want to get.

Returns: Shared pointer to the child effect at the given index.

◆ getChildCount()

unsigned int kanzi::EffectStack2D::getChildCount ( ) const

inline

Returns the number of child effects.

Returns: Number of child effects.

◆ getChildren()

ChildConstSpan kanzi::EffectStack2D::getChildren ( ) const

inline

Gets a span of child effects.

Returns: Span of child effects.

◆ createRendererOverride()

NodeEffectRenderer2DUniquePtr kanzi::EffectStack2D::createRendererOverride ( )

overrideprotectedvirtual

NodeEffect2D::createRendererOverride implementation.

Implements kanzi::NodeEffect2D.

◆ initializeRendererOverride()

void kanzi::EffectStack2D::initializeRendererOverride ( )

overrideprotectedvirtual

NodeEffect2D::initializeRendererOverride implementation.

Implements kanzi::NodeEffect2D.

◆ isRenderingRequiredOverride()

bool kanzi::EffectStack2D::isRenderingRequiredOverride ( )

overrideprotectedvirtual

NodeEffect2D::isRenderingRequiredOverride() implementation.

Reimplemented from kanzi::NodeEffect2D.

◆ lookupObjectOverride()

ObjectSharedPtr kanzi::EffectStack2D::lookupObjectOverride	(	string_view	initialPart,
		string_view	remainingPart )

overrideprotectedvirtual

NodeEffect2D::lookupObjectOverride() implementation.

Reimplemented from kanzi::NodeEffect2D.

◆ onAttached()

void kanzi::EffectStack2D::onAttached ( )

overrideprotectedvirtual

NodeEffect2D::onAttached() implementation.

Reimplemented from kanzi::NodeEffect2D.

◆ onDetached()

void kanzi::EffectStack2D::onDetached ( )

overrideprotectedvirtual

NodeEffect2D::onDetached() implementation.

Reimplemented from kanzi::NodeEffect2D.

◆ onPropertyChanged()

void kanzi::EffectStack2D::onPropertyChanged	(	AbstractPropertyType	propertyType,
		PropertyNotificationReason	reason )

overrideprotectedvirtual

Node2D::onPropertyChanged() implementation.

Reimplemented from kanzi::PropertyObject.

◆ updateEffectQuadPadding()

void kanzi::EffectStack2D::updateEffectQuadPadding ( )

protected

Updates NodeEffect2D effect quad padding based on the current child effects.

Member Data Documentation

◆ StackingModeProperty

PropertyType<StackingMode> kanzi::EffectStack2D::StackingModeProperty

static

Sets the effect stacking mode.

See also: StackingMode. The default value is StackingMode::Chained.; setStackingMode(), getStackingMode()

◆ m_children

ChildContainer kanzi::EffectStack2D::m_children

protected

Child effects.

The documentation for this class was generated from the following file:

kanzi/core.ui/effect/effect_stack2d.hpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Examples

Member Typedef Documentation

◆ ChildContainer

◆ ChildConstSpan

Member Enumeration Documentation

◆ StackingMode

Constructor & Destructor Documentation

◆ EffectStack2D()

Member Function Documentation

◆ getStackingMode()

◆ setStackingMode()

◆ makeEditorInfo()

◆ create()

◆ addChild()

◆ insertChild()

◆ getChildIndex()

◆ removeChild() [1/2]

◆ removeChild() [2/2]

◆ removeAllChildren()

◆ getChild()

◆ getChildCount()

◆ getChildren()

◆ createRendererOverride()

◆ initializeRendererOverride()

◆ isRenderingRequiredOverride()

◆ lookupObjectOverride()

◆ onAttached()

◆ onDetached()

◆ onPropertyChanged()

◆ updateEffectQuadPadding()

Member Data Documentation

◆ StackingModeProperty

◆ m_children